-
Notifications
You must be signed in to change notification settings - Fork 57
Add central glossary, additional abbreviations, links, and minor editorial changes #582
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…l changes to why-python.md
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
for more information, see https://pre-commit.ci
|
👋 Thanks for opening this PR! The Cookbook will be automatically built with GitHub Actions. To see the status of your deployment, click below. |
brian-rose
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This all looks great. I added some small edits and suggestions.
I see this PR as a "first stab" at implementing a comprehensive glossary for the whole book. We can and should open a new issue to track more full implementation of a book-wide glossary. Lots of the glossary terms defined here are used on other pages as well and should be tagged with {term} in the sources as appropriate.
Co-authored-by: Brian Rose <[email protected]>
Co-authored-by: Brian Rose <[email protected]>
Co-authored-by: Brian Rose <[email protected]>
Co-authored-by: Brian Rose <[email protected]>
Co-authored-by: Brian Rose <[email protected]>
|
Yeah, I imagine there are quite a few more terms and references to add throughout the book. I was planning to add some w/ the GitHub section updates as well. For context, the capitalization diffs in the abbreviations were my attempt to differentiate where there were proper nouns. This works too though and is probably easier to maintain. |
I totally appreciate that there are multiple correct editorial styles! For me, the cognitive load is reduced when I stick to the convention of capitalizing all abbreviations, and correspondingly capitalizing all words that contribute to the abbreviation. |
brian-rose
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One tiny additional edit, sorry!
Co-authored-by: Brian Rose <[email protected]>
brian-rose
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work @kafitzgerald!
This PR:
Closes #569 and partially addresses #571 (central glossary)
More detailed notes / references: